com.highdeal.admin.hci
Interface InstanceInfo

All Superinterfaces:

java.lang.Comparable<InstanceInfo>, XMLMarshallable

All Known Implementing Classes:

InstanceInfoImpl

public interface InstanceInfo
extends XMLMarshallable, java.lang.Comparable<InstanceInfo>

This Java interface represents the interface of the instance information; Consider the InstanceInfoImpl class. See the InstanceInfoImpl class for more info about the XML description.

See Also:

InstanceInfoImpl

Field Summary

static java.lang.String

TAG_NAME The XML tag name of this class: "instanceInfo"

Method Summary

InstanceInfo	duplicate() Copies this InstanceInfo into a new instance of InstanceInfo.
ServiceInfo.Address	getAddress(ServiceInfo.ServiceInfoType service) Gets the address defined for the service.
java.lang.String	getFullHost(ServiceInfo.ServiceInfoType service) Gets the host name defined for the service with the multi-homing information.
java.lang.String	getHost(ServiceInfo.ServiceInfoType service) Gets the host name defined for the service.
java.lang.String	getHostname() Gets the instance host name.
java.lang.String	getHTTPURL() Deprecated. Use getURL(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType) instead
InstanceId	getInstanceId() Returns the value of the instance ID.
java.lang.String	getInstanceName(boolean full) Returns the name (string representation of the InstanceId) or the full name ([<HTTP_HOST_NAME>]<INSTANCE_ID>) of the instance of the SAP CC system
int	getPort(ServiceInfo.ServiceInfoType service) Gets the port defined for the service.
ServiceInfo.ServiceInfoSecurity	getSecurity(ServiceInfo.ServiceInfoType service) Gets the security defined for the service.
ServiceInfo	getServiceInfo(ServiceInfo.ServiceInfoType serviceType) Returns the service information value, containing host value and port number.
java.lang.String	getURL(ServiceInfo.ServiceInfoType serviceType) Returns the URL for the service.
boolean	isHttpMultipleBinding() Deprecated. Use isMultipleBinding(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType) instead
boolean	isHTTPSecurityEnabled() Deprecated. Use getSecurity(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType) instead.
boolean	isMultipleBinding(ServiceInfo.ServiceInfoType serviceType) Returns true if the service is bound to all available addresses.
boolean	isServiceAvailable(ServiceInfo.ServiceInfoType serviceType) Returns true if the service is available.
boolean	isServiceEnabled(ServiceInfo.ServiceInfoType serviceType) Returns true if the service is available and enabled.
void	isValid() Throws an InvalidInstanceInfoException if the instance info is malformed or invalid.
void	setFullHost(ServiceInfo.ServiceInfoType service, java.lang.String host) Sets the host name defined for the service with the multi-homing information.
void	setHost(ServiceInfo.ServiceInfoType service, java.lang.String host) Sets the host name defined for the service.
void	setHTTPSecurityEnable(boolean flag) Deprecated. Use setSecurity(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType, com.highdeal.admin.hci.ServiceInfo.ServiceInfoSecurity) instead
void	setPort(ServiceInfo.ServiceInfoType service, int port) Sets the port defined for the service.
void	setSecurity(ServiceInfo.ServiceInfoType service, ServiceInfo.ServiceInfoSecurity security) Sets the security policy defined for the service.

Methods inherited from interface com.highdeal.hci.XMLMarshallable

addCharacterData, addChild, marshal, setAttributes

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TAG_NAME

static final java.lang.String TAG_NAME

The XML tag name of this class: "instanceInfo"

See Also:

Constant Field Values

Method Detail

getServiceInfo

ServiceInfo getServiceInfo(ServiceInfo.ServiceInfoType serviceType)

Returns the service information value, containing host value and port number.

Parameters:

serviceType - The service type, which is one among service info list

Returns:

The service information

getInstanceId

InstanceId getInstanceId()

Returns the value of the instance ID.

Returns:

The InstanceId instance ID) of the instance in the SAP CC system

getHostname

java.lang.String getHostname()

Gets the instance host name.

Returns:

The instance host name

duplicate

InstanceInfo duplicate()

Copies this InstanceInfo into a new instance of InstanceInfo.

Returns:

A new instance of InstanceInfo that is an exact copy of this instance

getAddress

ServiceInfo.Address getAddress(ServiceInfo.ServiceInfoType service)

Gets the address defined for the service.

Parameters:

service - value among service info list

Returns:

The address host name

getHost

java.lang.String getHost(ServiceInfo.ServiceInfoType service)

Gets the host name defined for the service.

Parameters:

service - A value among service info list

Returns:

The service host name

getFullHost

java.lang.String getFullHost(ServiceInfo.ServiceInfoType service)

Gets the host name defined for the service with the multi-homing information.

Parameters:

service - A value among service info list

Returns:

The service host name

getPort

int getPort(ServiceInfo.ServiceInfoType service)

Gets the port defined for the service.

Parameters:

service - A value among service info list

Returns:

The service port

getSecurity

ServiceInfo.ServiceInfoSecurity getSecurity(ServiceInfo.ServiceInfoType service)

Gets the security defined for the service.

Parameters:

service - A value among service info list

Returns:

The security

setFullHost

void setFullHost(ServiceInfo.ServiceInfoType service,
                 java.lang.String host)

Sets the host name defined for the service with the multi-homing information.

Parameters:

service - A value among service info list

host - The new service host name

setHost

void setHost(ServiceInfo.ServiceInfoType service,
             java.lang.String host)

Sets the host name defined for the service.

Parameters:

service - A value among service info list

host - The new service host name

setPort

void setPort(ServiceInfo.ServiceInfoType service,
             int port)

Sets the port defined for the service.

Parameters:

service - A value among service info list

port - The new service port

setSecurity

void setSecurity(ServiceInfo.ServiceInfoType service,
                 ServiceInfo.ServiceInfoSecurity security)

Sets the security policy defined for the service.

Parameters:

service - A value among service info list

security - The new security

isHTTPSecurityEnabled

@Deprecated
boolean isHTTPSecurityEnabled()

Deprecated. Use getSecurity(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType) instead.

Returns true if the HTTP service security is enabled.

Returns:

true indicates that HTTP service is secured; this is the default

setHTTPSecurityEnable

@Deprecated
void setHTTPSecurityEnable(boolean flag)

Deprecated. Use setSecurity(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType, com.highdeal.admin.hci.ServiceInfo.ServiceInfoSecurity) instead

Controls whether HTTP service secured or not.

Parameters:

flag - true if the HTTP service security is enabled

getHTTPURL

@Deprecated
java.lang.String getHTTPURL()

Deprecated. Use getURL(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType) instead

Returns the HTTP URL.

Returns:

The HTTP URL

getURL

java.lang.String getURL(ServiceInfo.ServiceInfoType serviceType)

Returns the URL for the service.

Parameters:

serviceType - A service value among service info list

Returns:

The URL of the service

isServiceAvailable

boolean isServiceAvailable(ServiceInfo.ServiceInfoType serviceType)

Returns true if the service is available.

Parameters:

serviceType - A service value among service info list

Returns:

true if the service is available, false otherwise

isServiceEnabled

boolean isServiceEnabled(ServiceInfo.ServiceInfoType serviceType)

Returns true if the service is available and enabled.

Parameters:

serviceType - The service value among service info list

Returns:

true if the service is enabled, false otherwise

isMultipleBinding

boolean isMultipleBinding(ServiceInfo.ServiceInfoType serviceType)

Returns true if the service is bound to all available addresses.

Parameters:

serviceType - A serviceType service value among service info list

Returns:

true if the service is bound to all available addresses, false otherwise

getInstanceName

java.lang.String getInstanceName(boolean full)

Returns the name (string representation of the InstanceId) or the full name ([<HTTP_HOST_NAME>]<INSTANCE_ID>) of the instance of the SAP CC system

• The full name has the following grammar: [<HTTP_HOST_NAME>]<INSTANCE_ID>
• The name is the string representation of the InstanceId

Parameters:

full - true to return the full name, false to return the string representation of the instance identifier

Returns:

The (full) name of this instance

isValid

void isValid()
             throws InvalidInstanceException

Throws an InvalidInstanceInfoException if the instance info is malformed or invalid.

Throws:

InvalidInstanceException - If the instance map is not valid

isHttpMultipleBinding

@Deprecated
boolean isHttpMultipleBinding()

Deprecated. Use isMultipleBinding(com.highdeal.admin.hci.ServiceInfo.ServiceInfoType) instead

Returns true if the HTTP server is bound to all available addresses.

Returns:

true if the HTTP server is bound to all available addresses, false otherwise